/*
 * Copyright (C) 2010-2011 Comcast Cable.  All Rights Reserved.
 */
package com.hercules.android.receiver.model.objects;

/**
 * <p>This class represents the animating an object from its current alpha value to a new value over a specified
 * duration. It is a simple JavaBean (POJO) that provides getters and setters for all private attributes and performs no
 * argument validation in the setters.</p>
 *
 * <p><strong>Thread safety:</strong>  This class is mutable and not thread safe.</p>
 *
 * @author saarixx, jmn
 * @version 1.0
 */
public class XREAlphaAnimation extends XREAnimationResource {

    /**
     * <p>The desired alpha value at the end of the animation, between 0 and 1.</p>
     *
     * <p>Can be any value.</p>
     *
     * <p>Has getter and setter.</p>
     */
    private double alpha;

    /**
     * <p>Creates new instance of {@link XREAlphaAnimation} class.</p>
     */
    public XREAlphaAnimation() {
        // empty constructor
    }

    /**
     * <p>Retrieves the desired alpha value at the end of the animation, between 0 and 1.</p>
     *
     * @return the desired alpha value at the end of the animation, between 0 and 1
     */
    public double getAlpha() {
        return alpha;
    }

    /**
     * <p>Sets the desired alpha value at the end of the animation, between 0 and 1.</p>
     *
     * @param alpha the desired alpha value at the end of the animation, between 0 and 1
     */
    public void setAlpha(double alpha) {
        this.alpha = alpha;
    }
}

